home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / qcktop26.zip / QCKTOP40.DOC < prev    next >
Text File  |  1991-04-16  |  45KB  |  1,164 lines
  1.                        Top40 - version 2.6
  2.  
  3.     WILDCAT! BBS, QuickBBS, and PowrBBS Top 40 user utility
  4.  
  5.                          January 7, 1990
  6.  
  7.                      Revised April 16, 1991
  8.  
  9.     (C) Copyright 1990 Judson McCranie.  All rights reserved.
  10.  
  11.                        Judson S. McCranie
  12.                        Mantissa Software
  13.                        1505 E. Park, #G4
  14.                        Valdosta, GA 31602
  15.                        Ph: (912) 242-1405
  16.  
  17. NOTE: This documentation applies to three versions of Top40:
  18. WCTop40 for Wildcat BBS, QckTop40 for QuickBBS, and PwrTop40 for
  19. PowrBBS.  The actual program files are prefixed with "WC", "Qck",
  20. or "Pwr" except for the output bulletin files.
  21.  
  22. The latest version of the program and support are available
  23. through:
  24.  
  25.                        Bad Lands (QuickBBS)
  26.                   300/1200/2400/9600 HST 8,N,1.
  27.                         Sysop: Andy Smith
  28.                          (912) 247-6977
  29.  
  30. This program is distributed on a "Shareware" (try-before-you-buy)
  31. basis.  You are free to copy it and to distribute copies at cost. 
  32. You may not alter the program (or its documentation) or sell it
  33. for profit.  
  34.  
  35. You may try this program for a period of 30 days.  If you
  36. continue to use this program after the 30 day period then you
  37. must register it by sending your the name of your board, the
  38. board's phone number, and your name & address along with the
  39. program name and version number with a $20 registration and
  40. license fee to me at the address above.  You will receive support
  41. for the program, announcements of new versions of this program,
  42. and information about several other programs.  Please send any
  43. inquires, comments, or suggestions to me at the address above.      
  44.  
  45.  
  46. WHAT IS TOP40:
  47.  
  48. Top40 is a Sysop utility designed to create over a dozen
  49. different top user bulletins.  It makes full use of the activity
  50. log and creates a user data file which is updated with each use. 
  51. The WC version of the program is designed to work with WILDCAT
  52. 2.xx but may work with previous versions.  The Qck version is
  53. designed to work with QuickBBS version 2.6x, but may work with
  54. other versions.  The Pwr version of the program is designed to
  55. work with PowrBBS version 1.30 but should work with other
  56. versions.
  57.  
  58. You should find the following files in the archived file.
  59.  
  60.   xxxTop40.DOC  this documentation file
  61.   Top40   .XM?  examples of bulletins
  62.   xxTop40I.EXE  sysop installation program (PwrT40I.EXE for Pwr)
  63.   xxxTop40.EXE  program to generate bulletins
  64.   WCTop40C.EXE  converts files from 1.5x format to 2.0x (WC only)
  65.   WCT40C23.EXE  converts files from 2.1x/2.2 to 2.3/2.4 (WC only)
  66.   ORDERBLK.DOC  registration form
  67.   OTHER   .DOC  other programs by this author
  68.  
  69. where xxx = "WC", "QCK", or "PWR" and xx = "WC", "QCK", or "PW".
  70.  
  71. The program will generate the following files in the current
  72. directory:
  73.  
  74.   xxTop40.OPT  generated by the installation program
  75.   xxTop40.DAT  generated by the main program
  76.   xxTop40.SIZ  generated by then main or conversion program
  77.  
  78. where xx = "WC", "Qck", or "Pwr".
  79.  
  80. These files should be in the same directory as the Top40 EXE
  81. files and that directory should be the current directory when
  82. Top40 is run (i.e. - don't run Top40 with a path).  You can
  83. specify a path to the activity log and user data files and a path
  84. to which the bulletin files will be written.
  85.  
  86. This program is a utility to add top user lists to the WILDCAT
  87. BBS, QuickBBS, or PowerBBS.  It can be run after each call or as
  88. an event.  You can specify the number of users that will appear
  89. on the list, or disable any report.  The program compiles reports
  90. of the top users of each of following from the activity log: 
  91.  
  92.      callers
  93.      posters (messages)
  94.      uploaders
  95.      downloaders
  96.      door openers
  97.      carrier droppers (Use as a bulletin if D/Cs are really bad)
  98.      security violators (recommended for yourself only)
  99.  
  100. Note: The program currently considers any termination of the call
  101. other than a normal logoff a "carrier drop".  It could more
  102. properly be called an abnormal termination or logoff.
  103.  
  104. It also will generate these compilation reports:
  105.  
  106.      newest users
  107.      best users (based of total points > 0)
  108.      BBS losers (based on total points < 1)
  109.      All users  (based on total points)
  110.      
  111.      triple list - report of any three of the above categories
  112.  
  113. Three "triple lists" are available.
  114.  
  115. The most unique feature is the list of the top users, which is
  116. based on a weighted point system.  For instance, you can assign 2
  117. points for each call, 1 point for each message, 10 points for
  118. each upload, -5 points for each download, -10 points for each
  119. security violation, etc.  The user's total points is based on
  120. this value calculated from his statistics.
  121.  
  122.     Item Used             Recommended Point Value
  123.  
  124.     Number of Calls                  1 to   2
  125.     Number of Messages posted        2 to   4
  126.     Number of Uploads               10 to  25
  127.     Number of Downloads             -5 to -15
  128.     Number of Door uses              1 to   3
  129.     Number of Carrier drops         -1 to  -3
  130.     Number of Security violations   -3 to  -5
  131.  
  132. Feel free to experiment with the point values until the resulting
  133. scores suit you.  You should probably consider a balance between
  134. the points for uploads and the points for downloads.  For
  135. instance, if you expect a 5:1 upload:download ratio, the point
  136. value for an upload should probably be 5 times as large (in
  137. absolute value) as the value for a download (e.g. +20 for an
  138. upload, -4 for a download).
  139.  
  140. The "newest users" is a list of the newest users.  The newest
  141. user will be #1 on the list, etc.  This should be encouraging to
  142. new users since they will get to see their names at the top of
  143. the list the next time they call.  Otherwise, it would be quite a
  144. while before they make any of the top user lists.
  145.  
  146.  
  147. CHANGES IN VERSION 2.6:
  148.  
  149. Added support for QuickBBS.
  150.  
  151.  
  152. CHANGES IN VERSION 2.5:
  153.  
  154. Fixed a bug in the Wildcat version installation program.  
  155.  
  156. Added the option of entering the name of the user data file.
  157.  
  158.  
  159. CHANGES IN VERSION 2.4:
  160.  
  161. Faster reading and writing of disk files.
  162.  
  163. Smaller EXE file.
  164.  
  165.  
  166. CHANGES IN VERSION 2.3:
  167.  
  168. Add support for PowrBBS.
  169.  
  170. Add an extension option for ASCII files.
  171.  
  172. New options file format.
  173.  
  174.  
  175. CHANGES IN VERSION 2.2:
  176.  
  177. The "Purge deleted users" choice in the installation program will
  178. delete any users from the Top40 data file that have been deleted
  179. from the Wildcat user data base.  The "Delete users" (which
  180. deleted individual users) has been removed from the installation
  181. program.  I no longer see a need for it, but if you think it
  182. should stay in the program please let me know.
  183.  
  184. The background color problem in the ANSI screens has been fixed. 
  185. (Thanks to Bob Lias for informing me of the problem.)
  186.  
  187. You can now specify the path to the user data file (USERFILE.DAT
  188. or USERS).
  189.  
  190.  
  191. CHANGES IN VERSION 2.14:
  192.  
  193. There was a bug in versions 2.1 through 2.13 in the "newest user
  194. list".  (Thanks to Cam DeBuck for pointing this out.)  See "How
  195. bugs creep into programs" for more details.
  196.  
  197.  
  198. CHANGES IN VERSION 2.1:
  199.  
  200.   Support for Wildcat version 2.15.
  201.  
  202.   Fix a bug when a user is deleted by WCRepair.
  203.  
  204.   Option of ANSI screens.
  205.  
  206.   Option of counting down to number 1 on the lists.
  207.  
  208.  
  209. SUMMARY OF CONVERSION FOR USERS OF VERSIONS PRIOR TO 2.3:
  210.  
  211. The options data file (WCTop40.OPT) has been reorganized.  You
  212. can't simply run the program with the old option file like you
  213. could when going from version 2.0x to 2.1x or 2.2, or from 2.1x
  214. to 2.2.  
  215.  
  216. Here is my recommendation for users of previous versions who
  217. which to upgrade to the current version while retaining their
  218. data.  There are several things you could do to upgrade the data
  219. files.  In all cases, I recommend making a backup copy of the
  220. data files before doing the conversion.  More details follow, but
  221. my recommendations are:
  222.  
  223. For users of 2.1x or 2.2, the easiest way to get to 2.4 (or 2.3x)
  224. is to run WCT40C23 to convert the options file to the new format,
  225. and then run the installation program and check all options.  In
  226. parti